home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 17 / CU Amiga Magazine's Super CD-ROM 17 (1997)(EMAP Images)(GB)[!][issue 1997-12].iso / CUCD / Programming / MUI / MCC_Time / Developer / Autodocs / MCC_Time.doc
Encoding:
Text File  |  1997-10-07  |  14.1 KB  |  631 lines
  1. TABLE OF CONTENTS
  2.  
  3. Time/--background--
  4. Time/MUIA_Time_ChangeDay
  5. Time/MUIA_Time_ChangeHour
  6. Time/MUIA_Time_DaylightSaving
  7. Time/MUIA_Time_Hour
  8. Time/MUIA_Time_MaxHour
  9. Time/MUIA_Time_MaxMinute
  10. Time/MUIA_Time_MaxSecond
  11. Time/MUIA_Time_MidnightSecs
  12. Time/MUIA_Time_Minute
  13. Time/MUIA_Time_MinHour
  14. Time/MUIA_Time_MinMinute
  15. Time/MUIA_Time_MinSecond
  16. Time/MUIA_Time_NextDay
  17. Time/MUIA_Time_PrevDay
  18. Time/MUIA_Time_Second
  19. Time/MUIA_Time_ZoneMinute
  20. Time/MUIM_Time_Compare
  21. Time/MUIM_Time_Decrease
  22. Time/MUIM_Time_Increase
  23. Time/MUIM_Time_SetCurrent
  24. Time/--background--
  25.  
  26.    NAME
  27.     Time -- ... (V12)
  28.  
  29.    FUNCTION
  30.     Time is an abstract Custom Class of the Magic User Interface © by
  31.     Stefan Stuntz.
  32.     It's a subclass of notify-class and only usable for developers who
  33.     want to build subclasses of Time.mcc!
  34.  
  35.     The idea of this class was born during developing my Gregor
  36.     application.
  37.  
  38.     MUI abstract public custom class that allowing easy handling of time.
  39.     Because it is abstract it is only usefull for developers working with
  40.     classes that are based on Time.mcc (like TimeString.mcc), or those
  41.     who want to build their own Time.mcc based classes.
  42.  
  43.    NOTES
  44.     None at the moment.
  45. Time/MUIA_Time_ChangeDay
  46.  
  47.    NAME
  48.     MUIA_Time_ChangeDay, UWORD [ISG] -- Is day a DS change day? (V12.1)
  49.  
  50.    SYNOPSIS
  51.     MUIA_Time_ChangeDay, MUIV_Time_ChangeDay_Normal,
  52.  
  53.     \*result =*\ set(obj,MUIA_Time_DaylightDay,cd);
  54.     \*result =*\ get(obj,MUIA_Time_DaylightDay,&cd);
  55.  
  56.    FUNCTION
  57.     The MUIA_Time_ChangeDay attribute defines if a daylight saving
  58.     change happens on the actual day.
  59.     Defaults to MUIV_Time_ChangeDay_Normal.
  60.  
  61.    RESULT
  62.     cd - MUIV_Time_ChangeDay_Normal         : Normal day
  63.          MUIV_Time_ChangeDay_WinterToSummer : Winter to summer time
  64.                                               change happens today
  65.          MUIV_Time_ChangeDay_SummerToWinter : Summer to winter time
  66.                                               change happens today
  67.  
  68.    NOTES
  69.     None.
  70.  
  71.    BUGS
  72.     No known bugs.
  73.  
  74.    SEE ALSO
  75.     MUIA_Time_ChangeHour, MUIA_Time_DaylightSaving
  76. Time/MUIA_Time_ChangeHour
  77.  
  78.    NAME
  79.     MUIA_Time_ChangeHour, UWORD [ISG] -- Change hour for DS (V12.1)
  80.  
  81.    SYNOPSIS
  82.     MUIA_Time_ChangeHour, 2,
  83.  
  84.     \*result =*\ set(obj,MUIA_Time_DaylightSaving,ch);
  85.     \*result =*\ get(obj,MUIA_Time_DaylightSaving,&ch);
  86.  
  87.    FUNCTION
  88.     The MUIA_Time_ChangeHour attribute defines the hour at which the
  89.     daylight saving change happens.
  90.     Defaults to 2.
  91.  
  92.    RESULT
  93.     ch - Change hour for daylight saving time.
  94.  
  95.    NOTES
  96.     None.
  97.  
  98.    BUGS
  99.     No known bugs.
  100.  
  101.    SEE ALSO
  102.     MUIA_Time_ChangeDay, MUIA_Time_DaylightSaving
  103. Time/MUIA_Time_DaylightSaving
  104.  
  105.    NAME
  106.     MUIA_Time_DaylightSaving, BOOL [ISG] -- Daylight saving status (V12.1)
  107.  
  108.    SYNOPSIS
  109.     MUIA_Time_DaylightSaving, FALSE,
  110.  
  111.     \*result =*\ set(obj,MUIA_Time_DaylightSaving,ds);
  112.     \*result =*\ get(obj,MUIA_Time_DaylightSaving,&ds);
  113.  
  114.    FUNCTION
  115.     The MUIA_Time_DaylightSaving attribute of a Time object reflects the
  116.     daylight saving status.
  117.     Defaults to FALSE.
  118.  
  119.    RESULT
  120.     ds - TRUE  : Daylight saving time.
  121.          FALSE : No daylight saving time.
  122.  
  123.    NOTES
  124.     When you define MaxTime and/or MinTime then changing the daylight
  125.     saving will set the time to MinTime/MaxTime by crossing these limits.
  126.  
  127.    BUGS
  128.     No known bugs.
  129.  
  130.    SEE ALSO
  131.     MUIM_Time_ZoneMinute, MUIA_Time_ChangeDay, MUIA_Time_ChangeHour
  132. Time/MUIA_Time_Hour
  133.  
  134.    NAME
  135.     MUIA_Time_Hour, UWORD [ISG] -- User selected hour (V12)
  136.  
  137.    SYNOPSIS
  138.     MUIA_Time_Hour,    0,
  139.  
  140.     \*result =*\ set(obj,MUIA_Time_Hour,hour);
  141.     \*result =*\ get(obj,MUIA_Time_Hour,&hour);
  142.  
  143.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_Hour,
  144.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  145.  
  146.    FUNCTION
  147.     The MUIA_Time_Hour attribute of a Time object is
  148.     triggered when a new object value is given.
  149.     Defaults to 0 if there was never a valid time value given!
  150.  
  151.    INPUTS
  152.     hour - Hour of the time value
  153.  
  154.    RESULT
  155.     hour - Hour of the time value
  156.  
  157.    NOTES
  158.     The hour is always in 24h format!
  159.     If you set a wrong time or if the time is not within MinTime and
  160.     MaxTime then this attribute will be set back to its default!
  161.  
  162.    BUGS
  163.     No known bugs.
  164.  
  165.    SEE ALSO
  166.     MUIA_Time_Minute, MUIA_Time_Second, MUIA_Time_ZoneMinute,
  167.     MUIA_Time_MidnightSecs
  168. Time/MUIA_Time_MaxHour
  169.  
  170.    NAME
  171.     MUIA_Time_MaxHour, UWORD [ISG] -- Hour of the max. time (V12.1)
  172.  
  173.    SYNOPSIS
  174.     MUIA_Time_MaxHour,    23,
  175.  
  176.     \*result =*\ set(obj,MUIA_Time_MaxHour,mhour);
  177.     \*result =*\ get(obj,MUIA_Time_MaxHour,&mhour);
  178.  
  179.    FUNCTION
  180.     The MUIA_Time_MaxHour attribute of a Time object is
  181.     the hour of the maximum time that can be set.
  182.     Defaults to 23.
  183.  
  184.    RESULT
  185.     mhour - Hour of the maximum time
  186.  
  187.    NOTES
  188.     If you set a wrong time or if MinTime is >= MaxTime then this
  189.     attribute will be set back to its default!
  190.  
  191.    BUGS
  192.     No known bugs.
  193.  
  194.    SEE ALSO
  195.     MUIA_Time_MaxMinute, MUIA_Time_MaxSecond
  196. Time/MUIA_Time_MaxMinute
  197.  
  198.    NAME
  199.     MUIA_Time_MaxMinute, UWORD [ISG] -- Minute of max. time (V12.1)
  200.  
  201.    SYNOPSIS
  202.     MUIA_Time_MaxMinute, 59,
  203.  
  204.     \*result =*\ set(obj,MUIA_Time_MaxMinute,mmin);
  205.     \*result =*\ get(obj,MUIA_Time_MaxMinute,&mmin);
  206.  
  207.    FUNCTION
  208.     The MUIA_Time_MaxMinute attribute of a Time object is
  209.     the minute of the maximum time that can be set.
  210.     Defaults to 59.
  211.  
  212.    INPUTS
  213.     mmin - Minute of the maximum time
  214.  
  215.    RESULT
  216.     mmin - Minute of the maximum time
  217.  
  218.    NOTES
  219.     If you set a wrong time or if MinTime is >= MaxTime then this
  220.     attribute will be set back to its default!
  221.  
  222.    BUGS
  223.     No known bugs.
  224.  
  225.    SEE ALSO
  226.     MUIA_Time_MaxHour, MUIA_Time_MaxSecond
  227. Time/MUIA_Time_MaxSecond
  228.  
  229.    NAME
  230.     MUIA_Time_MaxSecond, UWORD [ISG] -- Second of the max. time (V12.1)
  231.  
  232.    SYNOPSIS
  233.     MUIA_Time_MaxSecond, 59,
  234.  
  235.     \*result =*\ set(obj,MUIA_Time_MaxSecond,msec);
  236.     \*result =*\ get(obj,MUIA_Time_MaxSecond,&msec);
  237.  
  238.    FUNCTION
  239.     The MUIA_Time_MaxSecond attribute of a Time object is
  240.     the second of the maximum time that can be set.
  241.     Defaults to 59.
  242.  
  243.    INPUTS
  244.     msec - Second of the maximum time
  245.  
  246.    RESULT
  247.     msec - Second of the maximum time
  248.  
  249.    NOTES
  250.     If you set a wrong time or if MinTime is >= MaxTime then this
  251.     attribute will be set back to its default!
  252.  
  253.    BUGS
  254.     No known bugs.
  255.  
  256.    SEE ALSO
  257.     MUIA_Time_MaxHour, MUIA_Time_MaxMinute
  258. Time/MUIA_Time_MidnightSecs
  259.  
  260.    NAME
  261.     MUIA_Time_MidnightSecs, ULONG [ISG] -- Seconds since midnight (V12.2)
  262.  
  263.    SYNOPSIS
  264.     MUIA_Time_MidnightSecs, 0,
  265.  
  266.     \*result =*\ set(obj,MUIA_Time_MidnightSecs,secs);
  267.     \*result =*\ get(obj,MUIA_Time_MidnightSecs,&secs);
  268.  
  269.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_MidnightSecs,
  270.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  271.  
  272.    FUNCTION
  273.     The MUIA_Time_MidnightSecs attribute of a Time object is
  274.     triggered when a new value is given.
  275.     Defaults to 0 if there was never a valid time value given!
  276.  
  277.    INPUTS
  278.     secs - Seconds since midnight (0-86399)
  279.  
  280.    RESULT
  281.     secs - Seconds since midnight (0-86399)
  282.  
  283.    NOTES
  284.     If you set a wrong time or if the time is not within MinTime and
  285.     MaxTime then this attribute will be set back to its default!
  286.  
  287.    BUGS
  288.     No known bugs.
  289.  
  290.    SEE ALSO
  291.     MUIA_Time_Hour, MUIA_Time_Minute, MUIA_Time_Second
  292. Time/MUIA_Time_Minute
  293.  
  294.    NAME
  295.     MUIA_Time_Minute, UWORD [ISG] -- Used minute (V12)
  296.  
  297.    SYNOPSIS
  298.     MUIA_Time_Minute, 0,
  299.  
  300.     \*result =*\ set(obj,MUIA_Time_Minute,min);
  301.     \*result =*\ get(obj,MUIA_Time_Minute,&min);
  302.  
  303.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_Minute,
  304.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  305.  
  306.    FUNCTION
  307.     The MUIA_Time_Minute attribute of a Time object is
  308.     triggered when a new value is given.
  309.     Defaults to 0 if there was never a valid time value given!
  310.  
  311.    INPUTS
  312.     min - Minute of the time value
  313.  
  314.    RESULT
  315.     min - Minute of the time value
  316.  
  317.    NOTES
  318.     If you set a wrong time or if the time is not within MinTime and
  319.     MaxTime then this attribute will be set back to its default!
  320.  
  321.    BUGS
  322.     No known bugs.
  323.  
  324.    SEE ALSO
  325.     MUIA_Time_Hour, MUIA_Time_Second, MUIA_Time_ZoneMinute,
  326.     MUIA_Time_MidnightSecs
  327. Time/MUIA_Time_MinHour
  328.  
  329.    NAME
  330.     MUIA_Time_MinHour, UWORD [ISG] -- Hour of the min time (V12.1)
  331.  
  332.    SYNOPSIS
  333.     MUIA_Time_MinHour,    0,
  334.  
  335.     \*result =*\ set(obj,MUIA_Time_MinHour,mhour);
  336.     \*result =*\ get(obj,MUIA_Time_MinHour,&mhour);
  337.  
  338.    FUNCTION
  339.     The MUIA_Time_MinHour attribute of a Time object is
  340.     the hour of the minimum time that can be set.
  341.     Defaults to 0.
  342.  
  343.    RESULT
  344.     mhour - Hour of the minimum time
  345.  
  346.    NOTES
  347.     Always in 24h format!
  348.     If you set a wrong time or if MinTime is >= MaxTime then this
  349.     attribute will be set back to its default!
  350.  
  351.    BUGS
  352.     No known bugs.
  353.  
  354.    SEE ALSO
  355.     MUIA_Time_MinMinute, MUIA_Time_MinSecond
  356. Time/MUIA_Time_MinMinute
  357.  
  358.    NAME
  359.     MUIA_Time_MinMinute, UWORD [ISG] -- Minute of min. time (V12.1)
  360.  
  361.    SYNOPSIS
  362.     MUIA_Time_MinMinute, 0,
  363.  
  364.     \*result =*\ set(obj,MUIA_Time_MinMinute,mmin);
  365.     \*result =*\ get(obj,MUIA_Time_MinMinute,&mmin);
  366.  
  367.    FUNCTION
  368.     The MUIA_Time_MinMinute attribute of a Time object is
  369.     the minute of the minimum time that can be set.
  370.     Defaults to 0.
  371.  
  372.    INPUTS
  373.     mmin - Minute of the minimum time
  374.  
  375.    RESULT
  376.     mmin - Minute of the minimum time
  377.  
  378.    NOTES
  379.     If you set a wrong time or if MinTime is >= MaxTime then this
  380.     attribute will be set back to its default!
  381.  
  382.    BUGS
  383.     No known bugs.
  384.  
  385.    SEE ALSO
  386.     MUIA_Time_MinHour, MUIA_Time_MinSecond
  387. Time/MUIA_Time_MinSecond
  388.  
  389.    NAME
  390.     MUIA_Time_MinSecond, UWORD [ISG] -- Second of the min. time (V12.1)
  391.  
  392.    SYNOPSIS
  393.     MUIA_Time_MinSecond, 0,
  394.  
  395.     \*result =*\ set(obj,MUIA_Time_MinSecond,msec);
  396.     \*result =*\ get(obj,MUIA_Time_MinSecond,&msec);
  397.  
  398.    FUNCTION
  399.     The MUIA_Time_MinSecond attribute of a Time object is
  400.     the second of the minimum time that can be set.
  401.     Defaults to 0.
  402.  
  403.    INPUTS
  404.     msec - Second of the minimum time
  405.  
  406.    RESULT
  407.     msec - Second of the minimum time
  408.  
  409.    NOTES
  410.     If you set a wrong time or if MinTime is >= MaxTime then this
  411.     attribute will be set back to its default!
  412.  
  413.    BUGS
  414.     No known bugs.
  415.  
  416.    SEE ALSO
  417.     MUIA_Time_MinHour, MUIA_Time_MinMinute
  418. Time/MUIA_Time_NextDay
  419.  
  420.    NAME
  421.     MUIA_Time_NextDay, UWORD [..G] -- The next day has begun (V12)
  422.  
  423.    SYNOPSIS
  424.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_NextDay,
  425.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  426.  
  427.    FUNCTION
  428.     The MUIA_Time_NextDay attribute of a Time object will be triggered
  429.     when the time changes from MaxTime to MinTime
  430.     Defaults to 0.
  431.  
  432.    RESULT
  433.     nextday - Triggered when the next day begins.
  434.  
  435.    NOTES
  436.     None.
  437.  
  438.    BUGS
  439.     No known bugs.
  440.  
  441.    SEE ALSO
  442.     MUIM_Time_Increase
  443. Time/MUIA_Time_PrevDay
  444.  
  445.    NAME
  446.     MUIA_Time_PrevDay, UWORD [..G] -- Changed to previous day (V12)
  447.  
  448.    SYNOPSIS
  449.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_PrevDay,
  450.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  451.  
  452.    FUNCTION
  453.     The MUIA_Time_PrevDay attribute of a Time object will be triggered
  454.     when the time changes from MinTime to MaxTime
  455.     Defaults to 0.
  456.  
  457.    RESULT
  458.     prevday - Triggered when changed to the previous day.
  459.  
  460.    NOTES
  461.     None.
  462.  
  463.    BUGS
  464.     No known bugs.
  465.  
  466.    SEE ALSO
  467.     MUIM_Time_Decrease
  468. Time/MUIA_Time_Second
  469.  
  470.    NAME
  471.     MUIA_Time_Second, UWORD [ISG] -- Used second (V12)
  472.  
  473.    SYNOPSIS
  474.     MUIA_Time_Second, 0,
  475.  
  476.     \*result =*\ set(obj,MUIA_Time_Second,sec);
  477.     \*result =*\ get(obj,MUIA_Time_Second,&sec);
  478.  
  479.     \*result =*\ DoMethod(obj,MUIM_Notify,MUIA_Time_Second,
  480.         MUIV_EveryTime,STRINGOBJ,2,MUIM_String_Integer,MUIV_TriggerValue);
  481.  
  482.    FUNCTION
  483.     The MUIA_Time_Second attribute of a Time object is
  484.     triggered when a new value is given.
  485.     Defaults to 0 if there was never a valid time value given!
  486.  
  487.    INPUTS
  488.     sec - Second of the time value
  489.  
  490.    RESULT
  491.     sec - Second of the time value
  492.  
  493.    NOTES
  494.     If you set a wrong time or if the time is not within MinTime and
  495.     MaxTime then this attribute will be set back to its default!
  496.  
  497.    BUGS
  498.     No known bugs.
  499.  
  500.    SEE ALSO
  501.     MUIA_Time_Hour, MUIA_Time_Minute, MUIA_Time_ZoneMinute,
  502.     MUIA_Time_MidnightSecs
  503. Time/MUIA_Time_ZoneMinute
  504.  
  505.    NAME
  506.     MUIA_Time_ZoneMinute, WORD [ISG] -- Time zone (V12.1)
  507.  
  508.    SYNOPSIS
  509.     MUIA_Time_ZoneMinute, 60,
  510.  
  511.     \*result =*\ set(obj,MUIA_Time_ZoneMinute,zonemin);
  512.     \*result =*\ get(obj,MUIA_Time_ZoneMinute,&zonemin);
  513.  
  514.    FUNCTION
  515.     The MUIA_Time_ZoneMinute attribute of a Time object is
  516.     the time zone of the time that can be set (in minutes).
  517.     If the user gives a time string including a zone the time will be
  518.     recaclutated to this zone.
  519.     Defaults to 0 which is UCT also known as GMT.
  520.  
  521.    INPUTS
  522.     zonemin - Time zone of the time in minutes
  523.  
  524.    RESULT
  525.     zonemin - Time zone of the time in minutes
  526.  
  527.    NOTES
  528.     If you set a wrong zone then this attribute will be set back to its
  529.     default!
  530.     When you define MaxTime and/or MinTime then changing the zone will
  531.     set the time to MinTime/MaxTime by crossing these limits.
  532.  
  533.    BUGS
  534.     No known bugs.
  535.  
  536.    SEE ALSO
  537.     MUIA_Time_Hour, MUIA_Time_Minute, MUIA_Time_Second,
  538.     MUIA_Time_DaylightSaving
  539. Time/MUIM_Time_Compare
  540.  
  541.    NAME
  542.     MUIM_Time_Compare -- Compare with another time object (V12.3)
  543.  
  544.    SYNOPSIS
  545.     result = (LONG)DoMethod(obj,MUIM_Time_Compare,tobj);
  546.  
  547.    FUNCTION
  548.     Compares the time object with another time object.
  549.  
  550.    RESULT
  551.     result - -1 : obj < tobj : MUIV_Time_Compare_Less
  552.           0 : obj = tobj : MUIV_Time_Compare_Equal
  553.           1 : obj > tobj : MUIV_Time_Compare_Greater
  554.  
  555.    NOTES
  556.     The result is undefined when tobj is not a Time object!
  557.  
  558.    BUGS
  559.     No known bugs.
  560.  
  561.    SEE ALSO
  562.  
  563. Time/MUIM_Time_Decrease
  564.  
  565.    NAME
  566.     MUIM_Time_Decrease -- Decrease the time (V12)
  567.  
  568.    SYNOPSIS
  569.     \*result =*\ DoMethod(obj,MUIM_Time_Decrease,secs);
  570.  
  571.    FUNCTION
  572.     Decreases the time by seconds.
  573.  
  574.    INPUTS
  575.     secs - Seconds to sub from the time.
  576.  
  577.    NOTES
  578.     MUIM_Time_Decrease considers the Min- and MaxTime settings.
  579.     Having 08:00:00 as MinTime, 17:59:59 as MaxTime then
  580.     decreasing 09:00:00 by two hours will result into 17:00:00!
  581.  
  582.    BUGS
  583.     No known bugs.
  584.  
  585.    SEE ALSO
  586.     MUIM_Time_Increase, MUIA_Time_PrevDay
  587. Time/MUIM_Time_Increase
  588.  
  589.    NAME
  590.     MUIM_Time_Increase -- Increase the time (V12)
  591.  
  592.    SYNOPSIS
  593.     \*result =*\ DoMethod(obj,MUIM_Time_Increase,secs);
  594.  
  595.    FUNCTION
  596.     Increases the time by seconds.
  597.  
  598.    INPUTS
  599.     secs - Seconds to add to the time.
  600.  
  601.    NOTES
  602.     MUIM_Time_Increase considers the Min- and MaxTime settings.
  603.     Having 08:00:00 as MinTime, 17:59:59 as MaxTime then
  604.     increasing 17:00:00 by two hours will result into 09:00:00!
  605.  
  606.  
  607.    BUGS
  608.     No known bugs.
  609.  
  610.    SEE ALSO
  611.     MUIM_Time_Decrease, MUIA_Time_NextDay
  612. Time/MUIM_Time_SetCurrent
  613.  
  614.    NAME
  615.     MUIM_Time_SetCurrent -- Set the current time (V12)
  616.  
  617.    SYNOPSIS
  618.     \*result =*\ DoMethod(obj,MUIM_Time_SetCurrent);
  619.  
  620.    FUNCTION
  621.     Set the current time including the users time zone.
  622.  
  623.    NOTES
  624.     MinTime/MaxTime will be set when the current time exceeds these
  625.     limits.
  626.  
  627.    BUGS
  628.     No known bugs.
  629.  
  630.    SEE ALSO
  631.